Skip to content

gw-cache-buster.php: Fixed an issue where form validation would fail when Cache Buster was enabled globally. #1136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Jul 24, 2025
Merged

gw-cache-buster.php: Fixed an issue where form validation would fail when Cache Buster was enabled globally. #1136

merged 1 commit into from
Jul 24, 2025

Conversation

@SebastianWiz
Copy link
Contributor

@SebastianWiz SebastianWiz commented Jul 23, 2025

Context

⛑️ Ticket(s): https://secure.helpscout.net/conversation/2998377368/86389?viewId=8172236

Summary

Issue: When Cache Buster is enabled via the gfcb_enable_cache_buster filter, Cache Buster is forced to run on every form render, including the one during the validation request, which causes the issue. Whereas when Cache Buster is enabled via the shortcode attribute, form validation worked correctly since during Gravity Forms' validation request, it re-renders the form without re-evaluating the original shortcode attributes and therefor Cache Buster does not run.

Fix: Add a new check for $_POST['gform_submit'] inside the is_cache_busting_applicable() method. This will detect form submissions and disable Cache Buster to ensure Gravity Forms validation process can complete successfully.

@coderabbitai
Copy link

coderabbitai bot commented Jul 23, 2025 •
edited
Loading

Walkthrough

The logic of the is_cache_busting_applicable() method in the GW_Cache_Buster class was updated to immediately return false if the gform_submit key is present in the $_POST array, in addition to the existing cache-busting conditions.

Changes

File Change Summary
gravity-forms/gw-cache-buster.php Updated is_cache_busting_applicable() to check for gform_submit in $_POST and return false if set.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Note

⚡️ Unit Test Generation - Beta

CodeRabbit's unit test generation is now available in Beta! Automatically generate comprehensive unit tests for your code changes, ensuring better test coverage and catching edge cases you might miss. Our AI analyzes your code structure and creates tests that follow best practices and your project's testing patterns. Learn more here, or just try it under ✨ Finishing Touches.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7161a61 and 6c9b485.

📒 Files selected for processing (1)
  • gravity-forms/gw-cache-buster.php (1 hunks)
🔇 Additional comments (1)
gravity-forms/gw-cache-buster.php (1)

288-290: LGTM! Effective fix for the form validation issue.

The addition of the gform_submit check correctly prevents cache busting during form submissions and validation requests. This targeted approach addresses the core issue where cache busting would interfere with Gravity Forms' validation process when enabled globally via the gfcb_enable_cache_buster filter.

The early return pattern maintains good performance and code readability.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch seb/fix/86389-cache-buster-global-filter-validation

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@SebastianWiz SebastianWiz requested a review from saifsultanc July 23, 2025 22:46
@SebastianWiz SebastianWiz merged commit cf35e64 into master Jul 24, 2025
4 of 5 checks passed
@SebastianWiz SebastianWiz deleted the seb/fix/86389-cache-buster-global-filter-validation branch July 24, 2025 17:13
@coderabbitai coderabbitai bot mentioned this pull request Jul 31, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@saifsultanc saifsultanc saifsultanc approved these changes

Assignees

No one assigned

Labels

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@SebastianWiz @saifsultanc